Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Make CMD+Enter work for single-selection pages #9672

Merged
merged 4 commits into from
Jul 1, 2022
Merged

Make CMD+Enter work for single-selection pages #9672

merged 4 commits into from
Jul 1, 2022

Conversation

roryabraham
Copy link
Contributor

Details

This makes CMD+Enter work just like Enter on OptionsSelector components that support only a single selection instead of multiple selections.

Fixed Issues

$ #9594

Tests / QA Steps

Repeat the QA steps for #7702. On any pages where only a single selection is possible, replace Enter with CMD+Enter and everything should work as expected.

  • Verify that no errors appear in the JS console

PR Review Checklist

Contributor (PR Author) Checklist

  • I linked the correct issue in the ### Fixed Issues section above
  • I wrote clear testing steps that cover the changes made in this PR
    • I added steps for local testing in the Tests section
    • I added steps for Staging and/or Production testing in the QA steps section
    • I added steps to cover failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
    • I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
  • I included screenshots or videos for tests on all platforms
  • I ran the tests on all platforms & verified they passed on:
    • iOS / native
    • Android / native
    • iOS / Safari
    • Android / Chrome
    • MacOS / Chrome
    • MacOS / Desktop
  • I verified there are no console errors (if there’s a console error not related to the PR, report it or open an issue for it to be fixed)
  • I followed proper code patterns (see Reviewing the code)
    • I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick)
    • I verified that comments were added to code that is not self explanatory
    • I verified that any new or modified comments were clear, correct English, and explained “why” the code was doing something instead of only explaining “what” the code was doing.
    • I verified any copy / text shown in the product was added in all src/languages/* files
    • I verified any copy / text that was added to the app is correct English and approved by marketing by tagging the marketing team on the original GH to get the correct copy.
    • I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named “index.js”. All platform-specific files are named for the platform the code supports as outlined in the README.
    • I verified the JSDocs style guidelines (in STYLE.md) were followed
  • If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
  • I followed the guidelines as stated in the Review Guidelines
  • I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
  • I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
  • I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
  • If a new component is created I verified that:
    • A similar component doesn't exist in the codebase
    • All props are defined accurately and each prop has a /** comment above it */
    • Any functional components have the displayName property
    • The file is named correctly
    • The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
    • The only data being stored in the state is data necessary for rendering and nothing else
    • For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
    • Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
    • All JSX used for rendering exists in the render method
    • The component has the minimum amount of code necessary for its purpose and it is
  • If a new CSS style is added I verified that:
    • A similar style doesn’t already exist
    • The style can’t be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(themeColors.componentBG)
  • If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
  • If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.

PR Reviewer Checklist
  • I verified the correct issue is linked in the ### Fixed Issues section above
  • I verified testing steps are clear and they cover the changes made in this PR
    • I verified the steps for local testing are in the Tests section
    • I verified the steps for Staging and/or Production testing are in the QA steps section
    • I verified the steps cover any possible failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
    • I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
  • I checked that screenshots or videos are included for tests on all platforms
  • I verified tests pass on all platforms & I tested again on:
    • iOS / native
    • Android / native
    • iOS / Safari
    • Android / Chrome
    • MacOS / Chrome
    • MacOS / Desktop
  • I verified there are no console errors (if there’s a console error not related to the PR, report it or open an issue for it to be fixed)
  • I verified proper code patterns were followed (see Reviewing the code)
    • I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick).
    • I verified that comments were added to code that is not self explanatory
    • I verified that any new or modified comments were clear, correct English, and explained “why” the code was doing something instead of only explaining “what” the code was doing.
    • I verified any copy / text shown in the product was added in all src/languages/* files
    • I verified any copy / text that was added to the app is correct English and approved by marketing by tagging the marketing team on the original GH to get the correct copy.
    • I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named “index.js”. All platform-specific files are named for the platform the code supports as outlined in the README.
    • I verified the JSDocs style guidelines (in STYLE.md) were followed
  • If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
  • I verified that this PR follows the guidelines as stated in the Review Guidelines
  • I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
  • I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
  • If a new component is created I verified that:
    • A similar component doesn't exist in the codebase
    • All props are defined accurately and each prop has a /** comment above it */
    • Any functional components have the displayName property
    • The file is named correctly
    • The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
    • The only data being stored in the state is data necessary for rendering and nothing else
    • For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
    • Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
    • All JSX used for rendering exists in the render method
    • The component has the minimum amount of code necessary for its purpose and it is broken down into smaller components in order to separate concerns and functions
  • If a new CSS style is added I verified that:
    • A similar style doesn’t already exist
    • The style can’t be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(themeColors.componentBG)
  • If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
  • If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.

@roryabraham roryabraham self-assigned this Jul 1, 2022
@roryabraham roryabraham requested a review from a team July 1, 2022 18:59
@melvin-bot melvin-bot bot requested review from youssef-lr and removed request for a team July 1, 2022 18:59
@github-actions
Copy link
Contributor

github-actions bot commented Jul 1, 2022

⚠️ ⚠️ Heads up! This pull request has the CP Staging label. ⚠️ ⚠️
Merging it will cause it to be immediately deployed to staging, even if the open StagingDeployCash deploy checklist is locked.

marcaaron
marcaaron reviewed Jul 1, 2022
View reviewed changes
src/components/OptionsSelector.js
this.props.onConfirmSelection(focusedOption);
if (!focusedOption) {
return;
}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this be above the first check since the code inside that block is also using the focusedOption?

Copy link
Contributor Author

@roryabraham roryabraham Jul 1, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Moving this up as you've suggested breaks things, because it prevents CMD+Enter from creating a group chat if there are participants selected and the search bar is highlighted. But as it turns out, onConfirmSelection doesn't really need the focusedOption and that's not really it's intended use. I did an audit of all of it's usages:

  • here it's only ever triggered for group chats, and createGroup takes no arguments. So I clarified that and replaced the 1:1 createChat method with a noop.
  • here invite user takes no arguments
  • here finalizeParticipants takes no arguments.
  • here confirm take an argument that's only used by the sendMoney flow. And in the sendMoney flow onConfirmSelection is never called. I looked into splitting confirm into confirmSend and confirmRequest, but it feels out-of-scope and everything seems to be working as expected.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good eye though!

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok cool.

@roryabraham roryabraham requested a review from a team as a code owner July 1, 2022 20:38
@melvin-bot melvin-bot bot requested review from amyevans and removed request for a team July 1, 2022 20:38
amyevans
amyevans previously approved these changes Jul 1, 2022
View reviewed changes
marcaaron
marcaaron previously approved these changes Jul 1, 2022
View reviewed changes
src/components/OptionsSelector.js Outdated Show resolved Hide resolved
@roryabraham roryabraham dismissed stale reviews from marcaaron and amyevans via d616b01 July 1, 2022 22:59
@marcaaron marcaaron merged commit 7c2c5db into main Jul 1, 2022
@marcaaron marcaaron deleted the Rory-CMDEnter branch July 1, 2022 23:40
@melvin-bot melvin-bot bot added the Emergency label Jul 1, 2022
@melvin-bot
Copy link

melvin-bot bot commented Jul 1, 2022

@marcaaron looks like this was merged without passing tests. Please add a note explaining why this was done and remove the Emergency label if this is not an emergency.

@marcaaron
Copy link
Contributor

Was a pass

2022-07-01_13-41-30

OSBotify pushed a commit that referenced this pull request Jul 1, 2022
@marcaaron @OSBotify
Merge pull request #9672 from Expensify/Rory-CMDEnter
e92939f 
Make CMD+Enter work for single-selection pages

(cherry picked from commit 7c2c5db)
@OSBotify OSBotify mentioned this pull request Jul 1, 2022
Merged
OSBotify added a commit that referenced this pull request Jul 1, 2022
@OSBotify
Merge pull request #9684 from Expensify/OSBotify-cherry-pick-staging-…
9571971 
…9672

🍒 Cherry pick PR #9672 to staging 🍒
@OSBotify OSBotify mentioned this pull request Jul 1, 2022
Closed
71 tasks
@isagoico isagoico mentioned this pull request Jul 5, 2022
Closed
@OSBotify OSBotify mentioned this pull request Jul 8, 2022
Closed
@OSBotify
Copy link
Contributor

OSBotify commented Jul 8, 2022

🚀 Deployed to production by @roryabraham in version: 1.1.79-17 🚀

platform result
🤖 android 🤖 failure ❌
🖥 desktop 🖥 success ✅
🍎 iOS 🍎 success ✅
🕸 web 🕸 success ✅

@OSBotify OSBotify mentioned this pull request Aug 16, 2022
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@marcaaron marcaaron marcaaron approved these changes

@amyevans amyevans amyevans left review comments

@youssef-lr youssef-lr Awaiting requested review from youssef-lr

Assignees

@roryabraham roryabraham

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@roryabraham @marcaaron @OSBotify @amyevans